<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (c) 2004-2011 QOS.ch<a name="line.2"></a>
<span class="sourceLineNo">003</span> * All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * Permission is hereby granted, free  of charge, to any person obtaining<a name="line.5"></a>
<span class="sourceLineNo">006</span> * a  copy  of this  software  and  associated  documentation files  (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "Software"), to  deal in  the Software without  restriction, including<a name="line.7"></a>
<span class="sourceLineNo">008</span> * without limitation  the rights to  use, copy, modify,  merge, publish,<a name="line.8"></a>
<span class="sourceLineNo">009</span> * distribute,  sublicense, and/or sell  copies of  the Software,  and to<a name="line.9"></a>
<span class="sourceLineNo">010</span> * permit persons to whom the Software  is furnished to do so, subject to<a name="line.10"></a>
<span class="sourceLineNo">011</span> * the following conditions:<a name="line.11"></a>
<span class="sourceLineNo">012</span> *<a name="line.12"></a>
<span class="sourceLineNo">013</span> * The  above  copyright  notice  and  this permission  notice  shall  be<a name="line.13"></a>
<span class="sourceLineNo">014</span> * included in all copies or substantial portions of the Software.<a name="line.14"></a>
<span class="sourceLineNo">015</span> *<a name="line.15"></a>
<span class="sourceLineNo">016</span> * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,<a name="line.16"></a>
<span class="sourceLineNo">017</span> * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF<a name="line.17"></a>
<span class="sourceLineNo">018</span> * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND<a name="line.18"></a>
<span class="sourceLineNo">019</span> * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE<a name="line.19"></a>
<span class="sourceLineNo">020</span> * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION<a name="line.20"></a>
<span class="sourceLineNo">021</span> * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION<a name="line.21"></a>
<span class="sourceLineNo">022</span> * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> */<a name="line.24"></a>
<span class="sourceLineNo">025</span>package org.slf4j.instrumentation;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import javassist.CtBehavior;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import javassist.CtClass;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import javassist.CtMethod;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import javassist.Modifier;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import javassist.NotFoundException;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import javassist.bytecode.AttributeInfo;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import javassist.bytecode.CodeAttribute;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import javassist.bytecode.LocalVariableAttribute;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>/**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Helper methods for Javassist functionality.<a name="line.37"></a>
<span class="sourceLineNo">038</span> * <a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span>public class JavassistHelper {<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>    /**<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * Create a javassist source snippet which either is empty (for anything<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * which does not return a value) or a explanatory text around the $_<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * javassist return value variable.<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * <a name="line.46"></a>
<span class="sourceLineNo">047</span>     * @param method<a name="line.47"></a>
<span class="sourceLineNo">048</span>     *            descriptor of method<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * @return source snippet<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * @throws NotFoundException<a name="line.50"></a>
<span class="sourceLineNo">051</span>     */<a name="line.51"></a>
<span class="sourceLineNo">052</span>    public static String returnValue(CtBehavior method) throws NotFoundException {<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>        String returnValue = "";<a name="line.54"></a>
<span class="sourceLineNo">055</span>        if (methodReturnsValue(method)) {<a name="line.55"></a>
<span class="sourceLineNo">056</span>            returnValue = " returns: \" + $_ + \".";<a name="line.56"></a>
<span class="sourceLineNo">057</span>        }<a name="line.57"></a>
<span class="sourceLineNo">058</span>        return returnValue;<a name="line.58"></a>
<span class="sourceLineNo">059</span>    }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>    /**<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * determine if the given method returns a value, and return true if so.<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * false otherwise.<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * <a name="line.64"></a>
<span class="sourceLineNo">065</span>     * @param method<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * @return<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * @throws NotFoundException<a name="line.67"></a>
<span class="sourceLineNo">068</span>     */<a name="line.68"></a>
<span class="sourceLineNo">069</span>    private static boolean methodReturnsValue(CtBehavior method) throws NotFoundException {<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>        if (method instanceof CtMethod == false) {<a name="line.71"></a>
<span class="sourceLineNo">072</span>            return false;<a name="line.72"></a>
<span class="sourceLineNo">073</span>        }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>        CtClass returnType = ((CtMethod) method).getReturnType();<a name="line.75"></a>
<span class="sourceLineNo">076</span>        String returnTypeName = returnType.getName();<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span>        boolean isVoidMethod = "void".equals(returnTypeName);<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span>        boolean methodReturnsValue = isVoidMethod == false;<a name="line.80"></a>
<span class="sourceLineNo">081</span>        return methodReturnsValue;<a name="line.81"></a>
<span class="sourceLineNo">082</span>    }<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span>    /**<a name="line.84"></a>
<span class="sourceLineNo">085</span>     * Return javassist source snippet which lists all the parameters and their<a name="line.85"></a>
<span class="sourceLineNo">086</span>     * values. If available the source names are extracted from the debug<a name="line.86"></a>
<span class="sourceLineNo">087</span>     * information and used, otherwise just a number is shown.<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * <a name="line.88"></a>
<span class="sourceLineNo">089</span>     * @param method<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * @return<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * @throws NotFoundException<a name="line.91"></a>
<span class="sourceLineNo">092</span>     */<a name="line.92"></a>
<span class="sourceLineNo">093</span>    public static String getSignature(CtBehavior method) throws NotFoundException {<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span>        CtClass[] parameterTypes = method.getParameterTypes();<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span>        CodeAttribute codeAttribute = method.getMethodInfo().getCodeAttribute();<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span>        LocalVariableAttribute locals = null;<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span>        if (codeAttribute != null) {<a name="line.101"></a>
<span class="sourceLineNo">102</span>            AttributeInfo attribute;<a name="line.102"></a>
<span class="sourceLineNo">103</span>            attribute = codeAttribute.getAttribute("LocalVariableTable");<a name="line.103"></a>
<span class="sourceLineNo">104</span>            locals = (LocalVariableAttribute) attribute;<a name="line.104"></a>
<span class="sourceLineNo">105</span>        }<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span>        String methodName = method.getName();<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span>        StringBuilder sb = new StringBuilder(methodName).append("(\" ");<a name="line.109"></a>
<span class="sourceLineNo">110</span>        for (int i = 0; i &lt; parameterTypes.length; i++) {<a name="line.110"></a>
<span class="sourceLineNo">111</span>            if (i &gt; 0) {<a name="line.111"></a>
<span class="sourceLineNo">112</span>                // add a comma and a space between printed values<a name="line.112"></a>
<span class="sourceLineNo">113</span>                sb.append(" + \", \" ");<a name="line.113"></a>
<span class="sourceLineNo">114</span>            }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span>            CtClass parameterType = parameterTypes[i];<a name="line.116"></a>
<span class="sourceLineNo">117</span>            boolean isArray = parameterType.isArray();<a name="line.117"></a>
<span class="sourceLineNo">118</span>            CtClass arrayType = parameterType.getComponentType();<a name="line.118"></a>
<span class="sourceLineNo">119</span>            if (isArray) {<a name="line.119"></a>
<span class="sourceLineNo">120</span>                while (arrayType.isArray()) {<a name="line.120"></a>
<span class="sourceLineNo">121</span>                    arrayType = arrayType.getComponentType();<a name="line.121"></a>
<span class="sourceLineNo">122</span>                }<a name="line.122"></a>
<span class="sourceLineNo">123</span>            }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span>            sb.append(" + \"");<a name="line.125"></a>
<span class="sourceLineNo">126</span>            try {<a name="line.126"></a>
<span class="sourceLineNo">127</span>                sb.append(parameterNameFor(method, locals, i));<a name="line.127"></a>
<span class="sourceLineNo">128</span>            } catch (Exception e) {<a name="line.128"></a>
<span class="sourceLineNo">129</span>                sb.append(i + 1);<a name="line.129"></a>
<span class="sourceLineNo">130</span>            }<a name="line.130"></a>
<span class="sourceLineNo">131</span>            sb.append("\" + \"=");<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span>            if (parameterType.isPrimitive()) {<a name="line.133"></a>
<span class="sourceLineNo">134</span>                // let the compiler handle primitive -&gt; string<a name="line.134"></a>
<span class="sourceLineNo">135</span>                sb.append("\"+ $").append(i + 1);<a name="line.135"></a>
<span class="sourceLineNo">136</span>            } else {<a name="line.136"></a>
<span class="sourceLineNo">137</span>                String s = "org.slf4j.instrumentation.ToStringHelper.render";<a name="line.137"></a>
<span class="sourceLineNo">138</span>                sb.append("\"+ ").append(s).append("($").append(i + 1).append(')');<a name="line.138"></a>
<span class="sourceLineNo">139</span>            }<a name="line.139"></a>
<span class="sourceLineNo">140</span>        }<a name="line.140"></a>
<span class="sourceLineNo">141</span>        sb.append("+\")");<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span>        String signature = sb.toString();<a name="line.143"></a>
<span class="sourceLineNo">144</span>        return signature;<a name="line.144"></a>
<span class="sourceLineNo">145</span>    }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span>    /**<a name="line.147"></a>
<span class="sourceLineNo">148</span>     * Determine the name of parameter with index i in the given method. Use the<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * locals attributes about local variables from the classfile. Note: This is<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * still work in progress.<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * <a name="line.151"></a>
<span class="sourceLineNo">152</span>     * @param method<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * @param locals<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * @param i<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * @return the name of the parameter if available or a number if not.<a name="line.155"></a>
<span class="sourceLineNo">156</span>     */<a name="line.156"></a>
<span class="sourceLineNo">157</span>    static String parameterNameFor(CtBehavior method, LocalVariableAttribute locals, int i) {<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span>        if (locals == null) {<a name="line.159"></a>
<span class="sourceLineNo">160</span>            return Integer.toString(i + 1);<a name="line.160"></a>
<span class="sourceLineNo">161</span>        }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span>        int modifiers = method.getModifiers();<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span>        int j = i;<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span>        if (Modifier.isSynchronized(modifiers)) {<a name="line.167"></a>
<span class="sourceLineNo">168</span>            // skip object to synchronize upon.<a name="line.168"></a>
<span class="sourceLineNo">169</span>            j++;<a name="line.169"></a>
<span class="sourceLineNo">170</span>            // System.err.println("Synchronized");<a name="line.170"></a>
<span class="sourceLineNo">171</span>        }<a name="line.171"></a>
<span class="sourceLineNo">172</span>        if (Modifier.isStatic(modifiers) == false) {<a name="line.172"></a>
<span class="sourceLineNo">173</span>            // skip "this"<a name="line.173"></a>
<span class="sourceLineNo">174</span>            j++;<a name="line.174"></a>
<span class="sourceLineNo">175</span>            // System.err.println("Instance");<a name="line.175"></a>
<span class="sourceLineNo">176</span>        }<a name="line.176"></a>
<span class="sourceLineNo">177</span>        String variableName = locals.variableName(j);<a name="line.177"></a>
<span class="sourceLineNo">178</span>        // if (variableName.equals("this")) {<a name="line.178"></a>
<span class="sourceLineNo">179</span>        // System.err.println("'this' returned as a parameter name for "<a name="line.179"></a>
<span class="sourceLineNo">180</span>        // + method.getName() + " index " + j<a name="line.180"></a>
<span class="sourceLineNo">181</span>        // +<a name="line.181"></a>
<span class="sourceLineNo">182</span>        // ", names are probably shifted. Please submit source for class in slf4j bugreport");<a name="line.182"></a>
<span class="sourceLineNo">183</span>        // }<a name="line.183"></a>
<span class="sourceLineNo">184</span>        return variableName;<a name="line.184"></a>
<span class="sourceLineNo">185</span>    }<a name="line.185"></a>
<span class="sourceLineNo">186</span>}<a name="line.186"></a>




























































</pre>
</div>
</body>
</html>
